.TH slice2html 1

.SH NAME

slice2html - The Slice to HTML documentation tool.

.SH SYNOPSIS

slice2html [options] [files]

.SH DESCRIPTION

slice2html generates HTML documentation from Slice files.

Full documentation for slice2html is available online at:
.br
"https://doc.zeroc.com/display/Ice37/Generating+Slice+Documentation".

.SH OPTIONS

.TP
.BR \-h ", " \-\-help\fR
.br
Displays help message.

.TP
.BR \-v ", " \-\-version\fR
Displays the compiler version.

.TP
.BR \-DNAME\fR
.br
Defines the preprocessor symbol NAME.

.TP
.BR \-DNAME=DEF\fR
.br 
Defines the preprocessor symbol NAME with the value DEF.

.TP
.BR \-UNAME\fR
.br
Undefines the preprocessor symbol NAME.

.TP
.BR \-IDIR\fR
.br
Add the directory DIR to the search path for #include directives.

.TP
.BR \-E\fR
.br
Print the preprocessor output on stdout.

.TP
.BR \-\-output-dir " " DIR\fR
.br
Place the generated files into directory DIR.

.TP
.BR \-d ", " \-\-debug\fR
.br
Print debug information showing the operation of the Slice parser.

.TP
.BR \-\-ice\fR
.br
Permit use of the normally reserved prefix Ice for identifiers. Use this
option only when compiling the source code for the Ice run time.

.TP
.BR \-\-hdr " " FILE\fR
.br
Prepend FILE to each generated HTML file (except for _sindex.html). This
allows you to replace the HTML header and other preamble information with a
custom version, so you can connect style sheets to the generated pages. The
specified file must include the <body> tag (but need not end with a <body>
tag). FILE is expected to contain the string TITLE on a line by itself,
starting in column one. slice2html replaces the TITLE string with the
fully-scoped name of the Slice symbol that is documented on the corresponding
page.

.TP
.BR \-\-ftr " " FILE\fR
.br
Append FILE to each generated HTML file (except for _sindex.html). This allows
you to add, for example, a custom footer to each generated page. FILE must
end with a </body> tag.

.TP
.BR \-\-indexhdr " " FILE\fR
.br
slice2html generates a file _sindex.html that contains a table of contents of
all Slice symbols that hyperlink to the corresponding page. This option allows
you to replace the standard header with a custom header, for example, to attach
a JavaScript. The specified file must include the <body> tag (but need not end
with a <body> tag). The default value is the setting of --hdr (if any).

.TP
.BR \-\-indexftr " " FILE\fR
.br
Append FILE to the generated sindex.html page. This allows you to add, for
example, a custom footer to the table of contents, or to invoke a JavaScript. 
FILE is must end with a </body> tag. The default value is the setting of 
--ftr (if any).

.TP
.BR \-\-image\-dir " " DIR\fR
.br
With this option, slice2html looks in the specified directory for images to
use for the generated navigation hyperlinks. (Without this option, text links
are used instead.) Please see the generated HTML for the names of the various
image files. (They can easily be found by looking for img elements.)

.TP
.BR \-\-logo\-url " " URL\fR
.br
Use the specified URL as a hyperlink for the company logo that is added to
each page (if --image-dir is specified). The company logo is expected to be in
<image_dir>/logo.gif.

.TP
.BR \-\-search " " ACTION\fR
.br
If this option is specified, the generated pages contain a search box that 
allows you to connect the generated pages to a search engine. On pressing 
the "Search" button, the specified ACTION is carried out.

.TP
.BR \-\-index " " NUM\fR
.br
slice2html generates sub-indexes for various Slice symbols. This option
controls how many entries must be present before a sub-index is generated.
For example, if NUM is set to 3, a sub-index will be generated only if there
are three or more symbols that appear in that index. The default settings is
1, meaning that a sub-index is always generated. To disable sub-indexes
entirely, set NUM to 0.

.TP
.BR \-\-summary " " NUM\fR
.br
If this option is set, summary sentences that exceed NUM characters generate
a warning.

.SH SEE ALSO

.BR slice2cpp (1),
.BR slice2cs (1),
.BR slice2freeze (1),
.BR slice2freezej (1),
.BR slice2html (1),
.BR slice2java (1), 
.BR slice2php (1),
.BR slice2py (1),
.BR slice2rb (1)
